SherbyNet - /page/wikibook/entry.mu

Micron Document

<!DOCTYPE html>

<title>Windows Script File</title>

</head>

Windows Script File

</h1>

</header>

/* start https://en.wikipedia.org/ */

.mw-parser-output .infobox-subbox{padding:0;border:none;margin:-3px;width:auto;min-width:100%;font-size:100%;clear:none;float:none;background-color:transparent}.mw-parser-output .infobox-3cols-child{margin:auto}.mw-parser-output .infobox .navbar{font-size:100%}@media screen{html.skin-theme-clientpref-night .mw-parser-output .infobox-full-data:not(.notheme)>div:not(.notheme)[style]{background:#1f1f23!important;color:#f8f9fa}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .infobox-full-data:not(.notheme)>div:not(.notheme)[style]{background:#1f1f23!important;color:#f8f9fa}}@media(min-width:640px){body.skin--responsive .mw-parser-output .infobox-table{display:table!important}body.skin--responsive .mw-parser-output .infobox-table>caption{display:table-caption!important}body.skin--responsive .mw-parser-output .infobox-table>tbody{display:table-row-group}body.skin--responsive .mw-parser-output .infobox-table th,body.skin--responsive .mw-parser-output .infobox-table td{padding-left:inherit;padding-right:inherit}}

/* end https://en.wikipedia.org/ */

</style><table class="infobox"><tbody><tr><th colspan="2" class="infobox-above" style="padding-bottom: 0.15em;">Windows Script File</th></tr><tr><th scope="row" class="infobox-label" style="line-height: 1.2; padding-right: 0.65em;"><a href="Filename_extension" title="Filename extension">Filename extension</a></th><td class="infobox-data" style="line-height: 1.35;"><style data-mw-deduplicate="TemplateStyles:r886049734">

/* start https://en.wikipedia.org/ */

.mw-parser-output .monospaced{font-family:monospace,monospace}

/* end https://en.wikipedia.org/ */

</style><div class="monospaced">

<code>.wsf</code></div></td></tr><tr><th scope="row" class="infobox-label" style="line-height: 1.2; padding-right: 0.65em;"><a href="Media_type" title="Media type">Internet media type</a></th><td class="infobox-data" style="line-height: 1.35;">text/xml</td></tr><tr><th scope="row" class="infobox-label" style="line-height: 1.2; padding-right: 0.65em;">Developed by</th><td class="infobox-data" style="line-height: 1.35;"><a href="Microsoft" title="Microsoft">Microsoft</a></td></tr><tr><th scope="row" class="infobox-label" style="line-height: 1.2; padding-right: 0.65em;">Type of format</th><td class="infobox-data" style="line-height: 1.35;">Scripting</td></tr><tr><th scope="row" class="infobox-label" style="line-height: 1.2; padding-right: 0.65em;"><a href="Container_format" title="Container format">Container for</a></th><td class="infobox-data" style="line-height: 1.35;">Scripts</td></tr></tbody></table>

A Windows Script File (WSF) is a file type used by the <a href="Microsoft" title="Microsoft">Microsoft</a> <a href="Windows_Script_Host" title="Windows Script Host">Windows Script Host</a>. It allows mixing the <a href="Scripting_language" title="Scripting language">scripting languages</a> <a href="JScript" title="JScript">JScript</a> and <a href="VBScript" title="VBScript">VBScript</a> within a single file, or other scripting languages such as <a href="Perl" title="Perl">Perl</a>, <a href="Object_REXX" title="Object REXX">Object REXX</a>, <a href="Python_(programming_language)" title="Python (programming language)">Python</a>, or <a href="Kixtart" class="mw-redirect" title="Kixtart">Kixtart</a> if installed by the user. These types of scripts may also be used to link many other external scripts together using a <code>src</code> parameter on the <code class="nowrap" style=""><script></code> tag in a manner similar to <a href="HTML" title="HTML">HTML</a>. Windows Script Files have the extension <code>".WSF"</code>. A WSF makes reference to each script module in a very basic <a href="XML" title="XML">XML</a> hierarchy as shown below, adhering to those standards outside the <code class="nowrap" style=""><script></code> tags. Literal use of "<code class="nowrap" style=""></script></code>" or "<code class="nowrap" style=""><script></code>" inside your <code class="nowrap" style=""><script></code> tags and similar challenges can be handled by the use of <a href="CDATA" title="CDATA">CDATA</a>, as shown within the examples.

<div class="mw-heading mw-heading2"><h2 id="Error_isolation">Error isolation</h2></div>

A WSF may be useful for isolating errors. Its modular nature prevents one script reference from interfering with another. Here is a WSF example with one module that produces an error and one that does not:

' <![CDATA[

WScript.echo 4/0 ' Oh, boy! You cannot divide by zero...

' ]]>

</script>

' <![CDATA[

WScript.echo "Hello, Scripters!" & vbNewline & _

"Fantastic! It worked!"

' ]]>

</script>

</job>

</pre></div>

The first script module will produce a "divide by zero" error. Typically this would cause the script to end in the <a href="Windows_Script_Host" title="Windows Script Host">Windows Script Host</a> but this modular method allows the script to continue and execute the second script module.

<div class="mw-heading mw-heading2"><h2 id="Mixed_language_support">Mixed language support</h2></div>

A Windows Script File supports multiple languages, as described on the <a href="Windows_Script_Host" title="Windows Script Host">Windows Script Host</a> reference. One of the features of this file format is that you may use more than one at once. This means you can have one scripting language use code from another scripting language. The most memorable example for long-time <a href="VBScript" title="VBScript">VBScript</a> users is the use of Microsoft <a href="JScript" title="JScript">JScript</a> to service a sort request for <a href="VBScript" title="VBScript">VBScript</a> since it does not have a built-in sort function for an array of values. <a href="VBScript" title="VBScript">VBScript</a> users may write their own sort method or borrow one from an existing object like an ADO (<a href="ActiveX_Data_Objects" title="ActiveX Data Objects">ActiveX Data Objects</a>) <a href="Recordset" title="Recordset">Recordset</a> or a .NET (<a href=".NET_Framework" title=".NET Framework">.NET Framework</a>) <a href="ArrayList" class="mw-redirect" title="ArrayList">ArrayList</a>, but the fastest way to sort an array is to use the method built into <a href="JScript" title="JScript">JScript</a>. Here is a basic example of how that works:

function SortVBArray(arrVBArray) {return arrVBArray.toArray().sort();}

</script>

' <![CDATA[

'** Fastest sort: call the Jscript sort from VBScript

myData = "a,b,c,1,2,3,X,Y,Z,p,d,q"

wscript.echo "Original List of values: " & vbTab & myData

starttime = timer()

sortedArray = SortVBArray(split(myData,","))

endtime=timer()

jscriptTime = round(endtime-starttime,2)

wscript.echo "JScript sorted in " & jscriptTime & " seconds: " & vbTab & sortedArray

' ]]>

</script>

</job>

</pre></div>

The output looks like this, sorted by <a href="ASCII" title="ASCII">ASCII</a> code sequence:

<div class="mw-highlight mw-highlight-lang-output mw-content-ltr" dir="ltr"><pre>Original List of values: a,b,c,1,2,3,X,Y,Z,p,d,q

JScript sorted in 0 seconds: 1,2,3,X,Y,Z,a,b,c,d,p,q

</pre></div>

<div class="mw-heading mw-heading2"><h2 id="Exposing_constants">Exposing constants</h2></div>

Another very useful feature of a WSF is that the XML wrapper can be bound to an object reference or control so you can use that object's constants instead of having to declare them. In regular <a href="VBScript" title="VBScript">VBScript</a> and <a href="JScript" title="JScript">JScript</a> files, you would be forced to declare a constant's value (outside those that are internal to the <a href="Windows_Script_Host" title="Windows Script Host">Windows Script Host</a>) in order to use the constant. An example of this is shown below:

<div class="mw-highlight mw-highlight-lang-vbscript mw-content-ltr" dir="ltr"><pre>const adLockBatchOptimistic = 4

MsgBox "The value of ""adLockBatchOptimistic"" is " & _

adLockBatchOptimistic & ".", vbInformation,"adLockBatchOptimistic"

</pre></div>

If your object documentation only refers to the constant's name and not the constant's value, you would have no way of knowing the value without the help of an <a href="Integrated_development_environment" title="Integrated development environment">Integrated development environment</a> to tell you what they equate to. By using the WSF reference declaration, you can use the constants without declaring their values. The example below enumerates the values of several common constants in the ADO (<a href="ActiveX_Data_Objects" title="ActiveX Data Objects">ActiveX Data Objects</a>) <a href="Recordset" title="Recordset">Recordset</a>.

<!-- WSF Example with Object Reference

Notes for this very formal example:

CDATA is used to help the XML parser ignore

special characters in the content of the script.

The CDATA open and close must be masked

from VBScript by making them comments.

-->

' <![CDATA[

dim title, str, i

ctecArray = Array("adOpenUnspecified","adOpenForwardOnly", _

"adOpenKeyset","adOpenDynamic","adOpenStatic")

title = "ADO Recordset Values for Constants"

str = title & vbNewLine & vbNewLine

For i = 0 to ubound(ctecArray)

str = str & Eval(ctecArray(i)) & vbTab & ctecArray(i) & vbNewLine

Next

ltecArray = Array("adLockUnspecified","adLockReadOnly", _

"adLockPessimistic","adLockOptimistic", _

"adLockBatchOptimistic")

str = str & Eval(ltecArray(i)) & vbTab & ltecArray(i) & vbNewLine

Next

MsgBox str, vbInformation, Title

' ]]>

</script>

</job>

</package>

</pre></div>

Running the above script from a file with a <code>".WSF"</code> extension, such as one named <code>"EnumerateConstantsADO.wsf"</code>, will produce the result shown below:

<div class="mw-highlight mw-highlight-lang-output mw-content-ltr" dir="ltr"><pre>ADO Recordset Values for Constants

*CursorTypeEnum Constants*

-1 adOpenUnspecified

0 adOpenForwardOnly

1 adOpenKeyset

2 adOpenDynamic

3 adOpenStatic

*LockTypeEnum Constants*

-1 adLockUnspecified

1 adLockReadOnly

2 adLockPessimistic

3 adLockOptimistic

4 adLockBatchOptimistic

</pre></div>

In addition, using the object reference to expose the constants makes writing the script more like writing in a standard programming language. In fact, the contents of the sample script, written in VBScript, will actually compile into a <a href="Visual_Basic" title="Visual Basic">Visual Basic</a> program and run the same way as long as that program uses the same reference to ADODB.

<ul><li><a href="Active_Scripting" title="Active Scripting">Active Scripting</a></li>

<li><a href="Shell_script" title="Shell script">Shell script</a></li>

<li><a href="HTML_Application" title="HTML Application">HTML Application</a></li>

<li><a href="PowerShell" title="PowerShell">PowerShell</a></li></ul>

<div class="mw-heading mw-heading2"><h2 id="External_links">External links</h2></div>

<ul><li><a rel="nofollow" class="external text" href="https://web.archive.org/web/20160330040830/https://msdn.microsoft.com/en-us/library/15x4407c.aspx">Using Windows Script Files</a> - From <a href="The_Wayback_Machine" class="mw-redirect" title="The Wayback Machine">The WayBack Machine's</a> archive of a page from <a href="Microsoft" title="Microsoft">Microsoft's</a> website</li>

<li><a rel="nofollow" class="external text" href="https://web.archive.org/web/20090315062650/http://www.microsoft.com/technet/scriptcenter/scripts/language.mspx">Scripting Languages Available in the Script Center</a> - From <a href="The_Wayback_Machine" class="mw-redirect" title="The Wayback Machine">The WayBack Machine's</a> archive of a page from <a href="Microsoft" title="Microsoft">Microsoft's</a> website</li></ul></div><div><div class="zim-footer">

This article is issued from <a class="external text" title="Last edited on 2023-10-28" href="https://en.wikipedia.org/wiki/?title=Windows_Script_File&oldid=1182334919">Wikipedia</a>. The text is available under <a class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">Creative Commons Attribution-Share Alike 4.0</a> unless otherwise noted. Additional terms may apply for the media files.

</div>

</div></div>

</div>

</main>

</div>

</body></html>